Meshtastic App/com.geeksville.mesh/[androidJvm]AdminProtos/AdminMessage

AdminMessage

class AdminMessage : GeneratedMessage, AdminProtos.AdminMessageOrBuilder


This message is handled by the Admin module and is responsible for all settings/channel read/write operations.
This message is used to do settings operations to both remote AND local nodes.
(Prior to 1.2 these operations were done via special ToRadio operations)

Protobuf type meshtastic.AdminMessage

Types

BackupLocation

enum BackupLocation : ProtocolMessageEnum

Protobuf enum meshtastic.AdminMessage.BackupLocation

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , AdminProtos.AdminMessageOrBuilder


This message is handled by the Admin module and is responsible for all settings/channel read/write operations.
This message is used to do settings operations to both remote AND local nodes.
(Prior to 1.2 these operations were done via special ToRadio operations)

Protobuf type meshtastic.AdminMessage

ConfigType

enum ConfigType : ProtocolMessageEnum


TODO: REPLACE

Protobuf enum meshtastic.AdminMessage.ConfigType

InputEvent

class InputEvent : GeneratedMessage, AdminProtos.AdminMessage.InputEventOrBuilder


Input event message to be sent to the node.

Protobuf type meshtastic.AdminMessage.InputEvent

InputEventOrBuilder

interface InputEventOrBuilder : MessageOrBuilder

ModuleConfigType

enum ModuleConfigType : ProtocolMessageEnum


TODO: REPLACE

Protobuf enum meshtastic.AdminMessage.ModuleConfigType

PayloadVariantCase

enum PayloadVariantCase : Internal.EnumLite, AbstractMessageLite.InternalOneOfEnum

Properties

ADD_CONTACT_FIELD_NUMBER

val ADD_CONTACT_FIELD_NUMBER: Int = 66

BACKUP_PREFERENCES_FIELD_NUMBER

val BACKUP_PREFERENCES_FIELD_NUMBER: Int = 24

BEGIN_EDIT_SETTINGS_FIELD_NUMBER

val BEGIN_EDIT_SETTINGS_FIELD_NUMBER: Int = 64

COMMIT_EDIT_SETTINGS_FIELD_NUMBER

val COMMIT_EDIT_SETTINGS_FIELD_NUMBER: Int = 65

DELETE_FILE_REQUEST_FIELD_NUMBER

val DELETE_FILE_REQUEST_FIELD_NUMBER: Int = 22

ENTER_DFU_MODE_REQUEST_FIELD_NUMBER

val ENTER_DFU_MODE_REQUEST_FIELD_NUMBER: Int = 21

EXIT_SIMULATOR_FIELD_NUMBER

val EXIT_SIMULATOR_FIELD_NUMBER: Int = 96

FACTORY_RESET_CONFIG_FIELD_NUMBER

val FACTORY_RESET_CONFIG_FIELD_NUMBER: Int = 99

FACTORY_RESET_DEVICE_FIELD_NUMBER

val FACTORY_RESET_DEVICE_FIELD_NUMBER: Int = 94

GET_CANNED_MESSAGE_MODULE_MESSAGES_REQUEST_FIELD_NUMBER

val GET_CANNED_MESSAGE_MODULE_MESSAGES_REQUEST_FIELD_NUMBER: Int = 10

GET_CANNED_MESSAGE_MODULE_MESSAGES_RESPONSE_FIELD_NUMBER

val GET_CANNED_MESSAGE_MODULE_MESSAGES_RESPONSE_FIELD_NUMBER: Int = 11

GET_CHANNEL_REQUEST_FIELD_NUMBER

val GET_CHANNEL_REQUEST_FIELD_NUMBER: Int = 1

GET_CHANNEL_RESPONSE_FIELD_NUMBER

val GET_CHANNEL_RESPONSE_FIELD_NUMBER: Int = 2

GET_CONFIG_REQUEST_FIELD_NUMBER

val GET_CONFIG_REQUEST_FIELD_NUMBER: Int = 5

GET_CONFIG_RESPONSE_FIELD_NUMBER

val GET_CONFIG_RESPONSE_FIELD_NUMBER: Int = 6

GET_DEVICE_CONNECTION_STATUS_REQUEST_FIELD_NUMBER

val GET_DEVICE_CONNECTION_STATUS_REQUEST_FIELD_NUMBER: Int = 16

GET_DEVICE_CONNECTION_STATUS_RESPONSE_FIELD_NUMBER

val GET_DEVICE_CONNECTION_STATUS_RESPONSE_FIELD_NUMBER: Int = 17

GET_DEVICE_METADATA_REQUEST_FIELD_NUMBER

val GET_DEVICE_METADATA_REQUEST_FIELD_NUMBER: Int = 12

GET_DEVICE_METADATA_RESPONSE_FIELD_NUMBER

val GET_DEVICE_METADATA_RESPONSE_FIELD_NUMBER: Int = 13

GET_MODULE_CONFIG_REQUEST_FIELD_NUMBER

val GET_MODULE_CONFIG_REQUEST_FIELD_NUMBER: Int = 7

GET_MODULE_CONFIG_RESPONSE_FIELD_NUMBER

val GET_MODULE_CONFIG_RESPONSE_FIELD_NUMBER: Int = 8

GET_NODE_REMOTE_HARDWARE_PINS_REQUEST_FIELD_NUMBER

val GET_NODE_REMOTE_HARDWARE_PINS_REQUEST_FIELD_NUMBER: Int = 19

GET_NODE_REMOTE_HARDWARE_PINS_RESPONSE_FIELD_NUMBER

val GET_NODE_REMOTE_HARDWARE_PINS_RESPONSE_FIELD_NUMBER: Int = 20

GET_OWNER_REQUEST_FIELD_NUMBER

val GET_OWNER_REQUEST_FIELD_NUMBER: Int = 3

GET_OWNER_RESPONSE_FIELD_NUMBER

val GET_OWNER_RESPONSE_FIELD_NUMBER: Int = 4

GET_RINGTONE_REQUEST_FIELD_NUMBER

val GET_RINGTONE_REQUEST_FIELD_NUMBER: Int = 14

GET_RINGTONE_RESPONSE_FIELD_NUMBER

val GET_RINGTONE_RESPONSE_FIELD_NUMBER: Int = 15

GET_UI_CONFIG_REQUEST_FIELD_NUMBER

val GET_UI_CONFIG_REQUEST_FIELD_NUMBER: Int = 44

GET_UI_CONFIG_RESPONSE_FIELD_NUMBER

val GET_UI_CONFIG_RESPONSE_FIELD_NUMBER: Int = 45

KEY_VERIFICATION_FIELD_NUMBER

val KEY_VERIFICATION_FIELD_NUMBER: Int = 67

NODEDB_RESET_FIELD_NUMBER

val NODEDB_RESET_FIELD_NUMBER: Int = 100

REBOOT_OTA_SECONDS_FIELD_NUMBER

val REBOOT_OTA_SECONDS_FIELD_NUMBER: Int = 95

REBOOT_SECONDS_FIELD_NUMBER

val REBOOT_SECONDS_FIELD_NUMBER: Int = 97

REMOVE_BACKUP_PREFERENCES_FIELD_NUMBER

val REMOVE_BACKUP_PREFERENCES_FIELD_NUMBER: Int = 26

REMOVE_BY_NODENUM_FIELD_NUMBER

val REMOVE_BY_NODENUM_FIELD_NUMBER: Int = 38

REMOVE_FAVORITE_NODE_FIELD_NUMBER

val REMOVE_FAVORITE_NODE_FIELD_NUMBER: Int = 40

REMOVE_FIXED_POSITION_FIELD_NUMBER

val REMOVE_FIXED_POSITION_FIELD_NUMBER: Int = 42

REMOVE_IGNORED_NODE_FIELD_NUMBER

val REMOVE_IGNORED_NODE_FIELD_NUMBER: Int = 48

RESTORE_PREFERENCES_FIELD_NUMBER

val RESTORE_PREFERENCES_FIELD_NUMBER: Int = 25

SEND_INPUT_EVENT_FIELD_NUMBER

val SEND_INPUT_EVENT_FIELD_NUMBER: Int = 27

SESSION_PASSKEY_FIELD_NUMBER

val SESSION_PASSKEY_FIELD_NUMBER: Int = 101

SET_CANNED_MESSAGE_MODULE_MESSAGES_FIELD_NUMBER

val SET_CANNED_MESSAGE_MODULE_MESSAGES_FIELD_NUMBER: Int = 36

SET_CHANNEL_FIELD_NUMBER

val SET_CHANNEL_FIELD_NUMBER: Int = 33

SET_CONFIG_FIELD_NUMBER

val SET_CONFIG_FIELD_NUMBER: Int = 34

SET_FAVORITE_NODE_FIELD_NUMBER

val SET_FAVORITE_NODE_FIELD_NUMBER: Int = 39

SET_FIXED_POSITION_FIELD_NUMBER

val SET_FIXED_POSITION_FIELD_NUMBER: Int = 41

SET_HAM_MODE_FIELD_NUMBER

val SET_HAM_MODE_FIELD_NUMBER: Int = 18

SET_IGNORED_NODE_FIELD_NUMBER

val SET_IGNORED_NODE_FIELD_NUMBER: Int = 47

SET_MODULE_CONFIG_FIELD_NUMBER

val SET_MODULE_CONFIG_FIELD_NUMBER: Int = 35

SET_OWNER_FIELD_NUMBER

val SET_OWNER_FIELD_NUMBER: Int = 32

SET_RINGTONE_MESSAGE_FIELD_NUMBER

val SET_RINGTONE_MESSAGE_FIELD_NUMBER: Int = 37

SET_SCALE_FIELD_NUMBER

val SET_SCALE_FIELD_NUMBER: Int = 23

SET_TIME_ONLY_FIELD_NUMBER

val SET_TIME_ONLY_FIELD_NUMBER: Int = 43

SHUTDOWN_SECONDS_FIELD_NUMBER

val SHUTDOWN_SECONDS_FIELD_NUMBER: Int = 98

STORE_UI_CONFIG_FIELD_NUMBER

val STORE_UI_CONFIG_FIELD_NUMBER: Int = 46

Functions

copy

inline fun AdminProtos.AdminMessage.copy(block: AdminMessageKt.Dsl.() -> Unit): AdminProtos.AdminMessage

equals

open fun equals(obj: Any): Boolean

getAddContact

open fun getAddContact(): AdminProtos.SharedContact


Add a contact (User) to the nodedb

.meshtastic.SharedContact add_contact = 66;

getAddContactOrBuilder

open fun getAddContactOrBuilder(): AdminProtos.SharedContactOrBuilder


Add a contact (User) to the nodedb

.meshtastic.SharedContact add_contact = 66;

getBackupPreferences

open fun getBackupPreferences(): AdminProtos.AdminMessage.BackupLocation


Backup the node's preferences

.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;

getBackupPreferencesValue

open fun getBackupPreferencesValue(): Int


Backup the node's preferences

.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;

getBeginEditSettings

open fun getBeginEditSettings(): Boolean


Begins an edit transaction for config, module config, owner, and channel settings changes
This will delay the standard *implicit* save to the file system and subsequent reboot behavior until committed (commit_edit_settings)

bool begin_edit_settings = 64;

getCommitEditSettings

open fun getCommitEditSettings(): Boolean


Commits an open transaction for any edits made to config, module config, owner, and channel settings

bool commit_edit_settings = 65;

getDefaultInstance

open fun getDefaultInstance(): AdminProtos.AdminMessage

getDefaultInstanceForType

open fun getDefaultInstanceForType(): AdminProtos.AdminMessage

getDeleteFileRequest

open fun getDeleteFileRequest(): String


Delete the file by the specified path from the device

string delete_file_request = 22;

getDeleteFileRequestBytes

open fun getDeleteFileRequestBytes(): ByteString


Delete the file by the specified path from the device

string delete_file_request = 22;

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getEnterDfuModeRequest

open fun getEnterDfuModeRequest(): Boolean


Enter (UF2) DFU mode
Only implemented on NRF52 currently

bool enter_dfu_mode_request = 21;

getExitSimulator

open fun getExitSimulator(): Boolean


This message is only supported for the simulator Portduino build.
If received the simulator will exit successfully.

bool exit_simulator = 96;

getFactoryResetConfig

open fun getFactoryResetConfig(): Int


Tell the node to factory reset config; all device state and configuration will be returned to factory defaults; BLE bonds will be preserved.

int32 factory_reset_config = 99;

getFactoryResetDevice

open fun getFactoryResetDevice(): Int


Tell the node to factory reset config everything; all device state and configuration will be returned to factory defaults and BLE bonds will be cleared.

int32 factory_reset_device = 94;

getGetCannedMessageModuleMessagesRequest

open fun getGetCannedMessageModuleMessagesRequest(): Boolean


Get the Canned Message Module messages in the response to this message.

bool get_canned_message_module_messages_request = 10;

getGetCannedMessageModuleMessagesResponse

open fun getGetCannedMessageModuleMessagesResponse(): String


Get the Canned Message Module messages in the response to this message.

string get_canned_message_module_messages_response = 11;

getGetCannedMessageModuleMessagesResponseBytes

open fun getGetCannedMessageModuleMessagesResponseBytes(): ByteString


Get the Canned Message Module messages in the response to this message.

string get_canned_message_module_messages_response = 11;

getGetChannelRequest

open fun getGetChannelRequest(): Int


Send the specified channel in the response to this message
NOTE: This field is sent with the channel index + 1 (to ensure we never try to send 'zero' - which protobufs treats as not present)

uint32 get_channel_request = 1;

getGetChannelResponse

open fun getGetChannelResponse(): ChannelProtos.Channel


TODO: REPLACE

.meshtastic.Channel get_channel_response = 2;

getGetChannelResponseOrBuilder

open fun getGetChannelResponseOrBuilder(): ChannelProtos.ChannelOrBuilder


TODO: REPLACE

.meshtastic.Channel get_channel_response = 2;

getGetConfigRequest

open fun getGetConfigRequest(): AdminProtos.AdminMessage.ConfigType


Ask for the following config data to be sent

.meshtastic.AdminMessage.ConfigType get_config_request = 5;

getGetConfigRequestValue

open fun getGetConfigRequestValue(): Int


Ask for the following config data to be sent

.meshtastic.AdminMessage.ConfigType get_config_request = 5;

getGetConfigResponse

open fun getGetConfigResponse(): ConfigProtos.Config


Send the current Config in the response to this message.

.meshtastic.Config get_config_response = 6;

getGetConfigResponseOrBuilder

open fun getGetConfigResponseOrBuilder(): ConfigProtos.ConfigOrBuilder


Send the current Config in the response to this message.

.meshtastic.Config get_config_response = 6;

getGetDeviceConnectionStatusRequest

open fun getGetDeviceConnectionStatusRequest(): Boolean


Request the node to send it's connection status

bool get_device_connection_status_request = 16;

getGetDeviceConnectionStatusResponse

open fun getGetDeviceConnectionStatusResponse(): ConnStatusProtos.DeviceConnectionStatus


Device connection status response

.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;

getGetDeviceConnectionStatusResponseOrBuilder

open fun getGetDeviceConnectionStatusResponseOrBuilder(): ConnStatusProtos.DeviceConnectionStatusOrBuilder


Device connection status response

.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;

getGetDeviceMetadataRequest

open fun getGetDeviceMetadataRequest(): Boolean


Request the node to send device metadata (firmware, protobuf version, etc)

bool get_device_metadata_request = 12;

getGetDeviceMetadataResponse

open fun getGetDeviceMetadataResponse(): MeshProtos.DeviceMetadata


Device metadata response

.meshtastic.DeviceMetadata get_device_metadata_response = 13;

getGetDeviceMetadataResponseOrBuilder

open fun getGetDeviceMetadataResponseOrBuilder(): MeshProtos.DeviceMetadataOrBuilder


Device metadata response

.meshtastic.DeviceMetadata get_device_metadata_response = 13;

getGetModuleConfigRequest

open fun getGetModuleConfigRequest(): AdminProtos.AdminMessage.ModuleConfigType


Ask for the following config data to be sent

.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;

getGetModuleConfigRequestValue

open fun getGetModuleConfigRequestValue(): Int


Ask for the following config data to be sent

.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;

getGetModuleConfigResponse

open fun getGetModuleConfigResponse(): ModuleConfigProtos.ModuleConfig


Send the current Config in the response to this message.

.meshtastic.ModuleConfig get_module_config_response = 8;

getGetModuleConfigResponseOrBuilder

open fun getGetModuleConfigResponseOrBuilder(): ModuleConfigProtos.ModuleConfigOrBuilder


Send the current Config in the response to this message.

.meshtastic.ModuleConfig get_module_config_response = 8;

getGetNodeRemoteHardwarePinsRequest

open fun getGetNodeRemoteHardwarePinsRequest(): Boolean


Get the mesh's nodes with their available gpio pins for RemoteHardware module use

bool get_node_remote_hardware_pins_request = 19;

getGetNodeRemoteHardwarePinsResponse

open fun getGetNodeRemoteHardwarePinsResponse(): AdminProtos.NodeRemoteHardwarePinsResponse


Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use

.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;

getGetNodeRemoteHardwarePinsResponseOrBuilder

open fun getGetNodeRemoteHardwarePinsResponseOrBuilder(): AdminProtos.NodeRemoteHardwarePinsResponseOrBuilder


Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use

.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;

getGetOwnerRequest

open fun getGetOwnerRequest(): Boolean


Send the current owner data in the response to this message.

bool get_owner_request = 3;

getGetOwnerResponse

open fun getGetOwnerResponse(): MeshProtos.User


TODO: REPLACE

.meshtastic.User get_owner_response = 4;

getGetOwnerResponseOrBuilder

open fun getGetOwnerResponseOrBuilder(): MeshProtos.UserOrBuilder


TODO: REPLACE

.meshtastic.User get_owner_response = 4;

getGetRingtoneRequest

open fun getGetRingtoneRequest(): Boolean


Get the Ringtone in the response to this message.

bool get_ringtone_request = 14;

getGetRingtoneResponse

open fun getGetRingtoneResponse(): String


Get the Ringtone in the response to this message.

string get_ringtone_response = 15;

getGetRingtoneResponseBytes

open fun getGetRingtoneResponseBytes(): ByteString


Get the Ringtone in the response to this message.

string get_ringtone_response = 15;

getGetUiConfigRequest

open fun getGetUiConfigRequest(): Boolean


Tell the node to send the stored ui data.

bool get_ui_config_request = 44;

getGetUiConfigResponse

open fun getGetUiConfigResponse(): DeviceUIProtos.DeviceUIConfig


Reply stored device ui data.

.meshtastic.DeviceUIConfig get_ui_config_response = 45;

getGetUiConfigResponseOrBuilder

open fun getGetUiConfigResponseOrBuilder(): DeviceUIProtos.DeviceUIConfigOrBuilder


Reply stored device ui data.

.meshtastic.DeviceUIConfig get_ui_config_response = 45;

getKeyVerification

open fun getKeyVerification(): AdminProtos.KeyVerificationAdmin


Initiate or respond to a key verification request

.meshtastic.KeyVerificationAdmin key_verification = 67;

getKeyVerificationOrBuilder

open fun getKeyVerificationOrBuilder(): AdminProtos.KeyVerificationAdminOrBuilder


Initiate or respond to a key verification request

.meshtastic.KeyVerificationAdmin key_verification = 67;

getNodedbReset

open fun getNodedbReset(): Int


Tell the node to reset the nodedb.

int32 nodedb_reset = 100;

getParserForType

open fun getParserForType(): Parser<AdminProtos.AdminMessage>

getPayloadVariantCase

open fun getPayloadVariantCase(): AdminProtos.AdminMessage.PayloadVariantCase

getRebootOtaSeconds

open fun getRebootOtaSeconds(): Int


Tell the node to reboot into the OTA Firmware in this many seconds (or <0 to cancel reboot)
Only Implemented for ESP32 Devices. This needs to be issued to send a new main firmware via bluetooth.

int32 reboot_ota_seconds = 95;

getRebootSeconds

open fun getRebootSeconds(): Int


Tell the node to reboot in this many seconds (or <0 to cancel reboot)

int32 reboot_seconds = 97;

getRemoveBackupPreferences

open fun getRemoveBackupPreferences(): AdminProtos.AdminMessage.BackupLocation


Remove backups of the node's preferences

.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;

getRemoveBackupPreferencesValue

open fun getRemoveBackupPreferencesValue(): Int


Remove backups of the node's preferences

.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;

getRemoveByNodenum

open fun getRemoveByNodenum(): Int


Remove the node by the specified node-num from the NodeDB on the device

uint32 remove_by_nodenum = 38;

getRemoveFavoriteNode

open fun getRemoveFavoriteNode(): Int


Set specified node-num to be un-favorited on the NodeDB on the device

uint32 remove_favorite_node = 40;

getRemoveFixedPosition

open fun getRemoveFixedPosition(): Boolean


Clear fixed position coordinates and then set position.fixed_position = false

bool remove_fixed_position = 42;

getRemoveIgnoredNode

open fun getRemoveIgnoredNode(): Int


Set specified node-num to be un-ignored on the NodeDB on the device

uint32 remove_ignored_node = 48;

getRestorePreferences

open fun getRestorePreferences(): AdminProtos.AdminMessage.BackupLocation


Restore the node's preferences

.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;

getRestorePreferencesValue

open fun getRestorePreferencesValue(): Int


Restore the node's preferences

.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;

getSendInputEvent

open fun getSendInputEvent(): AdminProtos.AdminMessage.InputEvent


Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.

.meshtastic.AdminMessage.InputEvent send_input_event = 27;

getSendInputEventOrBuilder

open fun getSendInputEventOrBuilder(): AdminProtos.AdminMessage.InputEventOrBuilder


Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.

.meshtastic.AdminMessage.InputEvent send_input_event = 27;

getSerializedSize

open fun getSerializedSize(): Int

getSessionPasskey

open fun getSessionPasskey(): ByteString


The node generates this key and sends it with any get_x_response packets.
The client MUST include the same key with any set_x commands. Key expires after 300 seconds.
Prevents replay attacks for admin messages.

bytes session_passkey = 101;

getSetCannedMessageModuleMessages

open fun getSetCannedMessageModuleMessages(): String


Set the Canned Message Module messages text.

string set_canned_message_module_messages = 36;

getSetCannedMessageModuleMessagesBytes

open fun getSetCannedMessageModuleMessagesBytes(): ByteString


Set the Canned Message Module messages text.

string set_canned_message_module_messages = 36;

getSetChannel

open fun getSetChannel(): ChannelProtos.Channel


Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.

.meshtastic.Channel set_channel = 33;

getSetChannelOrBuilder

open fun getSetChannelOrBuilder(): ChannelProtos.ChannelOrBuilder


Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.

.meshtastic.Channel set_channel = 33;

getSetConfig

open fun getSetConfig(): ConfigProtos.Config


Set the current Config

.meshtastic.Config set_config = 34;

getSetConfigOrBuilder

open fun getSetConfigOrBuilder(): ConfigProtos.ConfigOrBuilder


Set the current Config

.meshtastic.Config set_config = 34;

getSetFavoriteNode

open fun getSetFavoriteNode(): Int


Set specified node-num to be favorited on the NodeDB on the device

uint32 set_favorite_node = 39;

getSetFixedPosition

open fun getSetFixedPosition(): MeshProtos.Position


Set fixed position data on the node and then set the position.fixed_position = true

.meshtastic.Position set_fixed_position = 41;

getSetFixedPositionOrBuilder

open fun getSetFixedPositionOrBuilder(): MeshProtos.PositionOrBuilder


Set fixed position data on the node and then set the position.fixed_position = true

.meshtastic.Position set_fixed_position = 41;

getSetHamMode

open fun getSetHamMode(): AdminProtos.HamParameters


Setup a node for licensed amateur (ham) radio operation

.meshtastic.HamParameters set_ham_mode = 18;

getSetHamModeOrBuilder

open fun getSetHamModeOrBuilder(): AdminProtos.HamParametersOrBuilder


Setup a node for licensed amateur (ham) radio operation

.meshtastic.HamParameters set_ham_mode = 18;

getSetIgnoredNode

open fun getSetIgnoredNode(): Int


Set specified node-num to be ignored on the NodeDB on the device

uint32 set_ignored_node = 47;

getSetModuleConfig

open fun getSetModuleConfig(): ModuleConfigProtos.ModuleConfig


Set the current Config

.meshtastic.ModuleConfig set_module_config = 35;

getSetModuleConfigOrBuilder

open fun getSetModuleConfigOrBuilder(): ModuleConfigProtos.ModuleConfigOrBuilder


Set the current Config

.meshtastic.ModuleConfig set_module_config = 35;

getSetOwner

open fun getSetOwner(): MeshProtos.User


Set the owner for this node

.meshtastic.User set_owner = 32;

getSetOwnerOrBuilder

open fun getSetOwnerOrBuilder(): MeshProtos.UserOrBuilder


Set the owner for this node

.meshtastic.User set_owner = 32;

getSetRingtoneMessage

open fun getSetRingtoneMessage(): String


Set the ringtone for ExternalNotification.

string set_ringtone_message = 37;

getSetRingtoneMessageBytes

open fun getSetRingtoneMessageBytes(): ByteString


Set the ringtone for ExternalNotification.

string set_ringtone_message = 37;

getSetScale

open fun getSetScale(): Int


Set zero and offset for scale chips

uint32 set_scale = 23;

getSetTimeOnly

open fun getSetTimeOnly(): Int


Set time only on the node
Convenience method to set the time on the node (as Net quality) without any other position data

fixed32 set_time_only = 43;

getShutdownSeconds

open fun getShutdownSeconds(): Int


Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)

int32 shutdown_seconds = 98;

getStoreUiConfig

open fun getStoreUiConfig(): DeviceUIProtos.DeviceUIConfig


Tell the node to store UI data persistently.

.meshtastic.DeviceUIConfig store_ui_config = 46;

getStoreUiConfigOrBuilder

open fun getStoreUiConfigOrBuilder(): DeviceUIProtos.DeviceUIConfigOrBuilder


Tell the node to store UI data persistently.

.meshtastic.DeviceUIConfig store_ui_config = 46;

hasAddContact

open fun hasAddContact(): Boolean


Add a contact (User) to the nodedb

.meshtastic.SharedContact add_contact = 66;

hasBackupPreferences

open fun hasBackupPreferences(): Boolean


Backup the node's preferences

.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;

hasBeginEditSettings

open fun hasBeginEditSettings(): Boolean


Begins an edit transaction for config, module config, owner, and channel settings changes
This will delay the standard *implicit* save to the file system and subsequent reboot behavior until committed (commit_edit_settings)

bool begin_edit_settings = 64;

hasCommitEditSettings

open fun hasCommitEditSettings(): Boolean


Commits an open transaction for any edits made to config, module config, owner, and channel settings

bool commit_edit_settings = 65;

hasDeleteFileRequest

open fun hasDeleteFileRequest(): Boolean


Delete the file by the specified path from the device

string delete_file_request = 22;

hasEnterDfuModeRequest

open fun hasEnterDfuModeRequest(): Boolean


Enter (UF2) DFU mode
Only implemented on NRF52 currently

bool enter_dfu_mode_request = 21;

hasExitSimulator

open fun hasExitSimulator(): Boolean


This message is only supported for the simulator Portduino build.
If received the simulator will exit successfully.

bool exit_simulator = 96;

hasFactoryResetConfig

open fun hasFactoryResetConfig(): Boolean


Tell the node to factory reset config; all device state and configuration will be returned to factory defaults; BLE bonds will be preserved.

int32 factory_reset_config = 99;

hasFactoryResetDevice

open fun hasFactoryResetDevice(): Boolean


Tell the node to factory reset config everything; all device state and configuration will be returned to factory defaults and BLE bonds will be cleared.

int32 factory_reset_device = 94;

hasGetCannedMessageModuleMessagesRequest

open fun hasGetCannedMessageModuleMessagesRequest(): Boolean


Get the Canned Message Module messages in the response to this message.

bool get_canned_message_module_messages_request = 10;

hasGetCannedMessageModuleMessagesResponse

open fun hasGetCannedMessageModuleMessagesResponse(): Boolean


Get the Canned Message Module messages in the response to this message.

string get_canned_message_module_messages_response = 11;

hasGetChannelRequest

open fun hasGetChannelRequest(): Boolean


Send the specified channel in the response to this message
NOTE: This field is sent with the channel index + 1 (to ensure we never try to send 'zero' - which protobufs treats as not present)

uint32 get_channel_request = 1;

hasGetChannelResponse

open fun hasGetChannelResponse(): Boolean


TODO: REPLACE

.meshtastic.Channel get_channel_response = 2;

hasGetConfigRequest

open fun hasGetConfigRequest(): Boolean


Ask for the following config data to be sent

.meshtastic.AdminMessage.ConfigType get_config_request = 5;

hasGetConfigResponse

open fun hasGetConfigResponse(): Boolean


Send the current Config in the response to this message.

.meshtastic.Config get_config_response = 6;

hasGetDeviceConnectionStatusRequest

open fun hasGetDeviceConnectionStatusRequest(): Boolean


Request the node to send it's connection status

bool get_device_connection_status_request = 16;

hasGetDeviceConnectionStatusResponse

open fun hasGetDeviceConnectionStatusResponse(): Boolean


Device connection status response

.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;

hasGetDeviceMetadataRequest

open fun hasGetDeviceMetadataRequest(): Boolean


Request the node to send device metadata (firmware, protobuf version, etc)

bool get_device_metadata_request = 12;

hasGetDeviceMetadataResponse

open fun hasGetDeviceMetadataResponse(): Boolean


Device metadata response

.meshtastic.DeviceMetadata get_device_metadata_response = 13;

hasGetModuleConfigRequest

open fun hasGetModuleConfigRequest(): Boolean


Ask for the following config data to be sent

.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;

hasGetModuleConfigResponse

open fun hasGetModuleConfigResponse(): Boolean


Send the current Config in the response to this message.

.meshtastic.ModuleConfig get_module_config_response = 8;

hasGetNodeRemoteHardwarePinsRequest

open fun hasGetNodeRemoteHardwarePinsRequest(): Boolean


Get the mesh's nodes with their available gpio pins for RemoteHardware module use

bool get_node_remote_hardware_pins_request = 19;

hasGetNodeRemoteHardwarePinsResponse

open fun hasGetNodeRemoteHardwarePinsResponse(): Boolean


Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use

.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;

hasGetOwnerRequest

open fun hasGetOwnerRequest(): Boolean


Send the current owner data in the response to this message.

bool get_owner_request = 3;

hasGetOwnerResponse

open fun hasGetOwnerResponse(): Boolean


TODO: REPLACE

.meshtastic.User get_owner_response = 4;

hasGetRingtoneRequest

open fun hasGetRingtoneRequest(): Boolean


Get the Ringtone in the response to this message.

bool get_ringtone_request = 14;

hasGetRingtoneResponse

open fun hasGetRingtoneResponse(): Boolean


Get the Ringtone in the response to this message.

string get_ringtone_response = 15;

hasGetUiConfigRequest

open fun hasGetUiConfigRequest(): Boolean


Tell the node to send the stored ui data.

bool get_ui_config_request = 44;

hasGetUiConfigResponse

open fun hasGetUiConfigResponse(): Boolean


Reply stored device ui data.

.meshtastic.DeviceUIConfig get_ui_config_response = 45;

hashCode

open fun hashCode(): Int

hasKeyVerification

open fun hasKeyVerification(): Boolean


Initiate or respond to a key verification request

.meshtastic.KeyVerificationAdmin key_verification = 67;

hasNodedbReset

open fun hasNodedbReset(): Boolean


Tell the node to reset the nodedb.

int32 nodedb_reset = 100;

hasRebootOtaSeconds

open fun hasRebootOtaSeconds(): Boolean


Tell the node to reboot into the OTA Firmware in this many seconds (or <0 to cancel reboot)
Only Implemented for ESP32 Devices. This needs to be issued to send a new main firmware via bluetooth.

int32 reboot_ota_seconds = 95;

hasRebootSeconds

open fun hasRebootSeconds(): Boolean


Tell the node to reboot in this many seconds (or <0 to cancel reboot)

int32 reboot_seconds = 97;

hasRemoveBackupPreferences

open fun hasRemoveBackupPreferences(): Boolean


Remove backups of the node's preferences

.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;

hasRemoveByNodenum

open fun hasRemoveByNodenum(): Boolean


Remove the node by the specified node-num from the NodeDB on the device

uint32 remove_by_nodenum = 38;

hasRemoveFavoriteNode

open fun hasRemoveFavoriteNode(): Boolean


Set specified node-num to be un-favorited on the NodeDB on the device

uint32 remove_favorite_node = 40;

hasRemoveFixedPosition

open fun hasRemoveFixedPosition(): Boolean


Clear fixed position coordinates and then set position.fixed_position = false

bool remove_fixed_position = 42;

hasRemoveIgnoredNode

open fun hasRemoveIgnoredNode(): Boolean


Set specified node-num to be un-ignored on the NodeDB on the device

uint32 remove_ignored_node = 48;

hasRestorePreferences

open fun hasRestorePreferences(): Boolean


Restore the node's preferences

.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;

hasSendInputEvent

open fun hasSendInputEvent(): Boolean


Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.

.meshtastic.AdminMessage.InputEvent send_input_event = 27;

hasSetCannedMessageModuleMessages

open fun hasSetCannedMessageModuleMessages(): Boolean


Set the Canned Message Module messages text.

string set_canned_message_module_messages = 36;

hasSetChannel

open fun hasSetChannel(): Boolean


Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.

.meshtastic.Channel set_channel = 33;

hasSetConfig

open fun hasSetConfig(): Boolean


Set the current Config

.meshtastic.Config set_config = 34;

hasSetFavoriteNode

open fun hasSetFavoriteNode(): Boolean


Set specified node-num to be favorited on the NodeDB on the device

uint32 set_favorite_node = 39;

hasSetFixedPosition

open fun hasSetFixedPosition(): Boolean


Set fixed position data on the node and then set the position.fixed_position = true

.meshtastic.Position set_fixed_position = 41;

hasSetHamMode

open fun hasSetHamMode(): Boolean


Setup a node for licensed amateur (ham) radio operation

.meshtastic.HamParameters set_ham_mode = 18;

hasSetIgnoredNode

open fun hasSetIgnoredNode(): Boolean


Set specified node-num to be ignored on the NodeDB on the device

uint32 set_ignored_node = 47;

hasSetModuleConfig

open fun hasSetModuleConfig(): Boolean


Set the current Config

.meshtastic.ModuleConfig set_module_config = 35;

hasSetOwner

open fun hasSetOwner(): Boolean


Set the owner for this node

.meshtastic.User set_owner = 32;

hasSetRingtoneMessage

open fun hasSetRingtoneMessage(): Boolean


Set the ringtone for ExternalNotification.

string set_ringtone_message = 37;

hasSetScale

open fun hasSetScale(): Boolean


Set zero and offset for scale chips

uint32 set_scale = 23;

hasSetTimeOnly

open fun hasSetTimeOnly(): Boolean


Set time only on the node
Convenience method to set the time on the node (as Net quality) without any other position data

fixed32 set_time_only = 43;

hasShutdownSeconds

open fun hasShutdownSeconds(): Boolean


Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)

int32 shutdown_seconds = 98;

hasStoreUiConfig

open fun hasStoreUiConfig(): Boolean


Tell the node to store UI data persistently.

.meshtastic.DeviceUIConfig store_ui_config = 46;

isInitialized

fun isInitialized(): Boolean

newBuilder

open fun newBuilder(): AdminProtos.AdminMessage.Builder

open fun newBuilder(prototype: AdminProtos.AdminMessage): AdminProtos.AdminMessage.Builder

newBuilderForType

open fun newBuilderForType(): AdminProtos.AdminMessage.Builder

parseDelimitedFrom

open fun parseDelimitedFrom(input: InputStream): AdminProtos.AdminMessage

open fun parseDelimitedFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): AdminProtos.AdminMessage

parseFrom

open fun parseFrom(data: Array<Byte>): AdminProtos.AdminMessage

open fun parseFrom(data: ByteString): AdminProtos.AdminMessage

open fun parseFrom(input: CodedInputStream): AdminProtos.AdminMessage

open fun parseFrom(input: InputStream): AdminProtos.AdminMessage

open fun parseFrom(data: ByteBuffer): AdminProtos.AdminMessage

open fun parseFrom(data: Array<Byte>, extensionRegistry: ExtensionRegistryLite): AdminProtos.AdminMessage

open fun parseFrom(data: ByteString, extensionRegistry: ExtensionRegistryLite): AdminProtos.AdminMessage

open fun parseFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): AdminProtos.AdminMessage

open fun parseFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): AdminProtos.AdminMessage

open fun parseFrom(data: ByteBuffer, extensionRegistry: ExtensionRegistryLite): AdminProtos.AdminMessage

parser

open fun parser(): Parser<AdminProtos.AdminMessage>

toBuilder

open fun toBuilder(): AdminProtos.AdminMessage.Builder

writeTo

open fun writeTo(output: CodedOutputStream)